/**
 *
 *  Copyright (c) 2011, AstroDAbis
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without modification,
 *  are permitted provided that the following conditions are met:
 *
 *      * Redistributions of source code must retain the above copyright notice,
 *        this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright notice,
 *        this list of conditions and the following disclaimer in the documentation
 *        and/or other materials provided with the distribution.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 *  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 *  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 *  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 *  OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
package org.jiscinvolve.astrodabis.mallow.model.jpa;

import org.jiscinvolve.astrodabis.mallow.model.api.Tag;
import org.jiscinvolve.astrodabis.mallow.model.api.Query;
import org.jiscinvolve.astrodabis.mallow.model.api.Result;
import org.jiscinvolve.astrodabis.mallow.model.api.Account;
import org.jiscinvolve.astrodabis.mallow.model.api.AccountManager;

import org.jiscinvolve.astrodabis.mallow.model.tap.TapJoin;
import org.jiscinvolve.astrodabis.mallow.model.tap.TapTable;
import org.jiscinvolve.astrodabis.mallow.model.tap.TapService;

import org.jiscinvolve.astrodabis.mallow.model.jpa.DuplicateEntryException;

/**
 * Public interface for our PersistentObject manager.
 *
 */
public interface PersistentManager
    {

    /**
     * Global manager for Accounts.
     *
     */
    public AccountManager accounts() ;

    /**
     * Global collection of Tags.
     *
     */
    public PersistentCollection<Tag, String> tags() ;

    /**
     * Global collection of Queries.
     *
     */
    public PersistentCollection<Query, String> queries() ;

    /**
     * Global collection of Results.
     *
     */
    public PersistentCollection<Result, Long> results() ;

    /**
     * Global collection of TapServices.
     *
     */
    public PersistentCollection<TapService, String> services() ;

    /**
     * Global collection of TapTables.
     *
     */
    public PersistentCollection<TapTable, String> tables() ;

    /**
     * Global collection of TapJoins.
     *
     */
    public PersistentCollection<TapJoin, String> joins() ;

    /**
     * Register a new account.
     *
     */
    public Account register(String name, String mail, String pass)
    throws DuplicateEntryException;

    }
